home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 42 / Amiga Format AFCD42 (Issue 126, Aug 1999).iso / -serious- / archivers / xfd / readme < prev    next >
Text File  |  1999-05-17  |  35KB  |  681 lines
  1.                       XFD Package - Release 1.25
  2.                       ==========================
  3.  
  4. COPYRIGHT
  5. ---------
  6. All  parts  of  this  software  package  are  freely  distributable for
  7. noncommercial use.  If you redistribute XFD, you have to keep all files
  8. together.  All programs are copyright by their authors.
  9.  
  10. DISCLAIMER
  11. ----------
  12. The  authors  are  not  liable  for any changes made to any part of the
  13. package, or consequences thereof as they cannot be made responsible for
  14. damages  or  loss  of  data  directly  or  indirectly  caused  by their
  15. software.
  16.  
  17. AUTHORS
  18. -------
  19. Georg Hörmann          - Definition of XFD standard, xfdmaster.library,
  20.                          xfd#? tools, Assembler includes, some external
  21.                          decrunchers.
  22. Dirk Stöcker           - External decrunchers, 'C' support and
  23.              xfdmaster.library starting with 38.5.
  24. Dexter&Bartman/Abyss   - External decrunchers.
  25. WEPL                   - External decrunchers and Oberon includes.
  26. ???                    - External decrunchers.
  27. A. Van Helsing/X-Trade - External decrunchers.
  28. Psygore                - External decrunchers.
  29. Mr.Larmer/Wanted Team  - External decrunchers.
  30. DII                    - External decruncher and older Amiga E stuff.
  31. Nils Görs              - External decruncher.
  32. Jan Poruba           - External decruncher.
  33. Sven Steiniger           - Amiga E support.
  34. Chris Young           - Installer script.
  35.  
  36. INTRODUCTION
  37. ------------
  38. Almost  every  Amiga  user  has  some  crunched files on his/her disks,
  39. either  Powerpacked docs or crunched demos, utilities or whatever.  But
  40. what to do when you need the files to be uncrunched, and you don't call
  41. the cruncher your own (or it does not support decrunching)? Enters XFD.
  42.  
  43. FEATURES
  44. --------
  45. This  software  package allows you to decrunch almost every packed file
  46. known  on the Amiga.  It consists of the xfdmaster.library as the brain
  47. and a couple of programs that offer certain functions to the user.
  48.  
  49. The  xfdmaster.library is a standard Amiga shared, runtime library.  It
  50. works  with  Kickstart  V33+ and offers applications the possibility to
  51. directly support any crunched files.
  52.  
  53. Other  than the predecessor decrunch.library, the xfdmaster.library has
  54. a  more  flexible interface, offers the possibility to decrunch already
  55. loaded  program  segments,  supports  external  decrunchers, is able to
  56. unlink 4EB9/4EF9- and text-linked files  and can scan for crunched data
  57. in any memory area.
  58.  
  59. REQUIREMENTS
  60. ------------
  61. xfdmaster.library  requires  OS1.2 to work  properly.  To decrunch XPKF
  62. files, you also need xpkmaster.library and the proper sub library.
  63.  
  64. All  included external  utilities need  OS2.0 or OS1.2 and arp.library,
  65. with exception of xfdPatch and xfdDecrunchAddr which always need OS2.0.
  66.  
  67. EXTERNAL DECRUNCHERS
  68. --------------------
  69. External  decrunchers  can  be easily written by any programmer who has
  70. knowledge  about the inner workings of a new cruncher.  That way almost
  71. everybody is able to keep the library up-to-date.  External decrunchers
  72. are  stored in "LIBS:xfd/" and xfdmaster.library loads them on startup.
  73. Please  check  out  your own "LIBS:xfd/" drawer and compare it with the
  74. latest  one included in this package.  The slaves from this package are
  75. always  the latest versions.  There exist old external decrunchers that
  76. are  no  longer  required,  please delete them from "LIBS:xfd/" to save
  77. diskspace AND memory.  They are mentioned in "LIBS:xfd/.README.FIRST"
  78.  
  79. ATTENTION
  80. ---------
  81. Although  I  clearly  stated  in the autodocs that external decrunchers
  82. have  to  be fully reentrant (which means they can handle several files
  83. within the same time), some externals are programmed not 100% safe.  If
  84. you  ever  have trouble with XFD, first disable the external slaves and
  85. then try again.  If there's still a problem, send me a bug report.
  86.  
  87. SUBMISSIONS
  88. -----------
  89. You are a programmer who has
  90. - developed external decrunchers for xfdmaster.library?
  91. - written applications that support xfdmaster.library?
  92. You have new crunchers that are not supported yet?
  93. Please send anything of the above to the following address:
  94.  
  95. ( Georg Hörmann            )
  96. ( Martinswinkelstraße 16c    )
  97. ( 82467 Garmisch-Partenkirchen    )
  98. ( Germany            )
  99.  
  100. As  Georg  has  no time  to improve  xfdmaster.library, he gave  me the
  101. sources to do further updates. Maybe in some future time he  will again
  102. make  the library  himself,  but at  the moment  I am the author of the
  103. xfdmaster.library.
  104.  
  105. You can contact me at:
  106. Dirk Stöcker
  107. Geschwister-Scholl-Straße 10
  108. 01877 Bischofswerda
  109. GERMANY
  110.  
  111. or "stoecker@amigaworld.com" or "dstoecker@gmx.de".
  112.  
  113. I still  need some of the  older crunchers,  strange data crunchers and
  114. lots of linkers. Any sent stuff is welcome.
  115.  
  116. THANKS
  117. ------
  118. Special  thanks  go  out  to  all the people who sent me new crunchers,
  119. external  decrunchers,  bug  reports  or  whatever.  You will find your
  120. names somewhere in the history.
  121.  
  122. HELP ME
  123. -------
  124. Who  is  interested  in writing a nice GUI for xfdmaster.library?  As I
  125. don't  have  enough  time to do this myself, I'm searching for somebody
  126. who  would  like  to  and has the skills to code a GUI-based all-in-one
  127. xfdDecrunch/Unlink/List/Scan  utility.   It  should read files, analyse
  128. them  quickly  (crunched?/linked?) scan them if necessary and save back
  129. the  result.   All  this  combined  with  lots  of  options and default
  130. settings would be very useful for all of us.
  131.  
  132. HISTORY
  133. -------
  134. XFD 1.25 [xfdmaster.library 39.2]
  135. - Fixed CP and ATOM slaves. The decrunch routines should not be able to
  136.   crash anymore. Thanks Mr. Larmer for the example files. These clients
  137.   are the first external V39 clients.
  138. - Fixed little bug in GZip slave.
  139. - Both executable test heads (C and ASM) support V39 auto allocation now.
  140. - Imploder Data slave bug fixed.
  141. - Updated some more clients to V39.
  142. - Fixed Enforcer hits in Crunch, 4GetIt!, ImploderClone clients and in
  143.   master library.
  144. - Added new Cruncher ID's MLDC & MD12 (PowerPacker), PAC/01 (RNC) and
  145.   Pack (StoneCracker 4.04). Thanks to Ronald van Dijk for example files.
  146. - Added or updated LOB, LZSS, NJMP, XPAC and Silmarils externals. Thanks
  147.   Don Adan for the files.
  148.  
  149. XFD 1.24 [xfdmaster.library 39.1]
  150. - Added support for TurboSqueezer5.1. Thanks to Richard Wagenführer for
  151.   sending the cruncher. Fixed TurboSqueezer6.1 Segment Decruncher. Added
  152.   xfdSegHead.a to source drawer. This header allows to test the segment
  153.   functions.
  154. - Again fixed PowerPacker4.0 Reloc correction routine. The library will no
  155.   longer crash for some defective files, but produce files which contain
  156.   additional stuff behind the real data. Using a file split utility to
  157.   remove that should produce a valid executable file again. This is a bug
  158.   of PowerPacker and not of xfdmaster.library.
  159. - Fixed broken error detection for PowerPacker files.
  160. - Added segment support to "MegaCruncher Obj".
  161. - Added "Unknown Cruncher 2" (Unknown2 external). Anyone who knows the
  162.   name of that address cruncher? Thanks Don Adan for some example files.
  163. - Added SubPacker1.0, a (lossy) ProTracker module packer. Thanks Martin
  164.   Jeppesen for the cruncher.
  165. - Fixed MasterCruncher3.0 Data detection (corrupted since Release 1.22).
  166. - Added Data scanning to Crunch1.3 slave.
  167. - Included PCR4 decruncher made by Jan Poruba.
  168. - Joined PMC and TurtleSmasher2.0 decrunch code and improved it a bit.
  169. - Fixed bug in StoneCracker data slaves.
  170. - Added auto buffer allocation feature. When USERTARGET is supported the
  171.   master library automatically allocates the buffer for client. Added
  172.   xfdrr_MinSourceLen field to allow easy buffer truncation checks. The
  173.   decrunch routine of data slaves can be really short now, when the format
  174.   allows to supply size information in Recog function.
  175. - Bumped version to 39.
  176. - Updated internal slaves to support new features. As a result some more
  177.   of the data slaves support USERTARGET now.
  178. - Added FileShield linker. Thanks to Heiner Schneegold for example files.
  179.   NOTE: The first unlinked file is really useless, as it contains only
  180.   1 zero word and 3 RTS instructions.
  181.  
  182. XFD 1.23 [xfdmaster.library 38.7]
  183. - Updated AddressHead to support 2 more headers (total 10 now).
  184. - Fixed bug in PowerPacker4.0 Reloc correction routine, which caused a
  185.   crash